home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pchat312.zip / PROCHAT.DOC < prev    next >
Text File  |  1992-09-23  |  25KB  |  551 lines
  1.       //////  //////     ///      ////   //// ////    //   //////
  2.       //  //  //  //   // //    //  //   //   //    ////  / // /
  3.      //  //  //  //  //   //  //        //   //   //  //   //
  4.     /////   /////   //   //  //        ///////   //  //   //
  5.    //      // //   //   //  //        //   //   //////   //
  6.   //      //  //   // //    //  //   //   //   //  //   //
  7. ////    //// //    ///      ////   //// ////  //  //  ////
  8.  
  9.                                            ////        //
  10.                                          //  //      ///
  11.                                             //       //
  12.                                          ///        //
  13.                                           //       //
  14.                                      //  //  //   //
  15.                                      ////   //  ////
  16.  
  17.               Documentation for ProChat 3.1 beta 2
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55. INTRODUCTION
  56. ------------
  57.      Welcome to ProChat!  For those of you that do not already know
  58. what ProChat is, you have been missing out!  Simply put, ProChat is
  59. a replacement door for PCBoard 14.5's CHAT or NODE function
  60. commands.  It allows quite a bit more flexibility with the CB
  61. system, and is currently enjoyed by hundreds of PCBoard systems
  62. internationally!
  63.  
  64.      If you do not run a multi-node PCBoard system, this door is of
  65. no use to you.  If you are running a non-PCBoard system, the door
  66. will not work even with the most sophisticated of door conversion
  67. utilities because ProChat takes full advantage of many of PCBoard's
  68. internal data structures (namely the node status data file that is
  69. maintained constantly by PCBoard while other callers are online)
  70.  
  71. GETTING STARTED
  72. ---------------
  73.      Getting ProChat up and running is not a difficult task and
  74. should not take any more than about 10 or 15 minutes of your time. 
  75. Even if it does take more, it will be well worth it.  Should you
  76. decide to customize ProChat to make it seem a part of PCBoard, it
  77. will take you a bit longer.  However, care has been taken to mimic
  78. PCBoard as much as possible.
  79.  
  80.      First off, make ProChat it's own directory.  Place the
  81. contents of the ProChat .ZIP file into this directory.  There is no
  82. need to make multiple configuration files for each node on your
  83. system.  There is no node-specific information stored in the main
  84. configuration file.
  85.  
  86.      To create a configuration file (or at least modify the one
  87. that is included with the distribution files), run the setup
  88. program.  Type SETUP <config filename>, where <config filename> is
  89. the name of the configuration file you wish to create/modify.  A
  90. default one has been supplied for you (PROCHAT.CNF)  Even if you
  91. decide to use the default configuration file, you must run setup to
  92. modify the paths and filenames to point to the appropriate
  93. locations on your hard drive.  The setup program is outlined in
  94. detail in the next section of the documentation.
  95.  
  96.      Next, create a batch file to run ProChat.  Since ProChat is
  97. based on ProKit, you may be familiar with the format for the batch
  98. files to load a ProKit door.  An example batch file for ProChat is
  99. below:
  100.  
  101. @echo off
  102. c:
  103. cd\prochat
  104. prochat prochat.cnf c:\pcb1
  105. cd\pcb1
  106. if exist event.bat event
  107. node1                                                                           <-- command to reload your system
  108.  
  109.      Last, but not least, modify your doors.lst file in PCBoard to
  110. reflect the addition of your new door.  A common name to give the
  111. batch file is just CB, that way users can just type CB at the main
  112. PCBoard menu and drop right into ProChat.  Don't forget to modify
  113. your doors menu file so that your users know that it is there!
  114.  
  115.      To go a step further, you may wish to modify your PCBTEXT
  116. file(s).  ProChat allows users to page others in PCBoard.  In order
  117. to do this, some changes are needed for your PCBTEXT file to let
  118. users know that they are being paged to go into ProChat and not the
  119. built in CHAT facility inside PCBoard.  Below is a list of record
  120. numbers you may wish to modify and what you may to change them to. 
  121. If you are running ProChat in /X mode (using USERNET.XXX instead of
  122. USERNET.DAT), you may decide not to modify your PCBTEXT file
  123. because ProChat takes advantage of the new BR command to notify
  124. users of a ProChat chat request.
  125.  
  126. 225: " wants you in ProChat, @FIRST@."
  127. 226: "To respond, at the main Command line enter CB."
  128. 227: "Node CHAT: (U)navailable, (Enter)=no change?"
  129. 228: "Node CHAT: (A)vailable, (Enter)=no change?"
  130. 311: "CHATTING in ProChat"
  131.  
  132.      Please also note that you should not raise the security on the
  133. CHAT command in PCBSetup.  Doing so will prevent users from paging
  134. others inside of PCBoard from ProChat.
  135.  
  136. THE SETUP PROGRAM
  137. -----------------
  138.      The setup program was included with ProChat for a couple of
  139. reasons.  Most importantly being the fact that ProChat stores
  140. configuration information in binary format.  It was also included
  141. to make your life a little bit easier in setting up the system.
  142.  
  143.      When you run setup, you can place the name of the
  144. configuration file on the command line.  If you do not place the
  145. filename on the command line, you will be prompted for a filename
  146. for the configuration file when setup loads.
  147.  
  148.      The setup program is fairly easy to use and is pretty much
  149. self-explanatory.  This section will outline the use of the
  150. program.  There are basically four different types of fields that
  151. can be modified.  They are strings, numbers, toggles, and lists. 
  152. If you press the F2 key at any input field, you will be toggled
  153. between the general setup screen and the security level setup
  154. screen.
  155.                When editing strings, the field is automatically formatted to
  156. uppercase, lowercase, mixed, or none for you.  Use the right and
  157. left arrow keys to move the cursor around the field, backspace and
  158. delete to remove text, home to go to the beginning of the field,
  159. end to go to the end of the field, and insert to insert text. 
  160. Pressing ctrl-end will delete from the cursor to the end of the
  161. field.  If you press ctrl-left or ctrl-right, the cursor will move
  162. one word to the left or to the right.
  163.  
  164.      When editing numbers, use the right and left arrow keys to
  165. move around the field, backspace and delete to delete, home to go
  166. to the beginning of the field, and end to go to the end of the
  167. field.  Pressing ctrl-end will delete from the cursor to the end of
  168. the field.  If you enter a value that is out of range, you will not
  169. be able to move to another field until a valid value is entered.
  170.  
  171.      When editing toggles, pressing the space bar will toggle from
  172. yes to no and vice-versa.  If you press 'y', it will switch to yes,
  173. and if you press 'n', it will switch to no.
  174.  
  175.      When editing lists, there are a couple of stages.  The first
  176. stage is when you first move onto the field, and the field is high-
  177. lighted.  Pressing the space bar or enter will cause a window with
  178. a list in it to pop up.  This is stage two.  Use the up and down
  179. arrow keys to move through the list and press enter to choose the
  180. item you want to set the field to.  If you press ESC while in stage
  181. two, any changes to the field will be aborted.  If you pressed
  182. enter to pop up the window, when a selection is made, you will be
  183. moved down to the next field, otherwise you will be back at stage
  184. one on the same field.
  185.  
  186.      When you are editing any one of the four types of fields, you
  187. always have the option of exiting the program (and saving any
  188. changes made) by pressing the ESC key.  If you press tab, enter, or
  189. the down arrow, you will be moved on to the next field.  If you
  190. press shift-tab or the up arrow, you will be moved back to the
  191. previous field.
  192.  
  193. SETUP PAGE 1
  194. ------------
  195. PCBoard node information file    This is the full path and name of
  196. your usernet.dat file (or usernet.xxx file).  This file is
  197. maintained by PCBoard to determine who is online and to send chat
  198. requests to other nodes.  This must be the same for all nodes.
  199.  
  200. ProChat node information file    This is the full path and name of
  201. the file used by ProChat to determine who is online, what channel
  202. the caller is on, etc.  This file is created and maintained by
  203. ProChat itself.  No intervention on your part is required.  This
  204. must be the same for all nodes.
  205. ProChat chat data file    This is the full path and name of the
  206. file used by ProChat to relay messages between the callers in
  207. ProChat.  This file is created and maintained by ProChat itself. 
  208. You should delete it every so often because it can grow quite large
  209. in size.  I recommend that you delete this file while no one is in
  210. ProChat, however you may delete it while callers are in ProChat
  211. without a problem.  This must be the same for all nodes.
  212.  
  213. ProChat channel data file    This is the full path and name of the
  214. file used by ProChat to maintain a list of currently active
  215. channels and squelch values.  This file is created and maintained
  216. by ProChat itself.  No intervention on your part is required.  This
  217. must be the same for all nodes.
  218.  
  219. Bad Handle Trashcan file    This is the full path and name of the
  220. file that restrict names that may be used for handles.  This file
  221. is a straight ascii file that contains a list of names that you may
  222. not want users to use for a handle (ie Sysop, etc)  If you place an
  223. asterisk (*) in the first column on a line followed by some text,
  224. the text will not be allowed in a handle (ie *Sysop would not allow
  225. a caller to use _Sysop_ or anything with the text 'Sysop' in it)
  226.  
  227. Caller Help Display file    This is the full path and name of the
  228. file that is displayed to a caller when the /HE command is executed
  229. in ProChat.  Both ascii and ansi versions may be used (ie HELP and
  230. HELPG)
  231.  
  232. ProChat Entrance display file    This is the full path and name of
  233. the file that is displayed to a caller when he/she enters ProChat. 
  234. This is an optional file.  Both ascii and ansi versions may be
  235. used.
  236.  
  237. Registered To    This field should not be filled in if you have not
  238. registered ProChat.  If you have registered ProChat, simply place
  239. the name of your BBS as you have it registered with me in this
  240. field.  It is case sensitive.  Make sure that there are no leading
  241. or trailing spaces in this field, otherwise ProChat will run as
  242. unregistered.
  243.  
  244. Registration #    This field should not be filled in if you have
  245. not registered ProChat.  If you have registered ProChat, simply
  246. place the registration number that I have given you in this field.
  247.  
  248. Driver Type    This list-type field allows you to choose between
  249. BIOS and INTERRUPT for communications.  This is the same as the
  250. first line in any ProKit configuration file.  Choose interrupt for
  251. starters.  If you have problems, try using bios.
  252.  
  253. PCBoard Version    This field is extremely important.  In this
  254. field, place either "/Exx", "/U", or "/Xxx" where xx is the number
  255. of nodes.  By placing "/U", the system will default to 99 nodes. 
  256. If you are running PCBoard with the new usernet.xxx format, you
  257. must place "/Xxx" in this field with xx being the number of nodes
  258. you have online.  Should you add an additional node to your system,
  259. you must remember to update this field, otherwise ProChat will not
  260. recognize the new node(s).
  261.  
  262. Number of channels    This is the number of channels available. 
  263. ProChat is limited to 65535 channels.  However, no more than about
  264. 100 should ever be necessary, and in most instances, no more than
  265. about 10 are needed.  You must have at least 1 channel set up in
  266. this field.
  267.  
  268. Default Channel    This is the channel that ProChat should place a
  269. caller into when the caller first enters CB.  Normally this would
  270. be channel 1.  You may configure the system to enter users into
  271. another channel depending upon the conference the user entered
  272. from, etc.
  273.  
  274. Default Squelch    This is the squelch that ProChat should place a
  275. caller into when the caller first enters CB.  Normally this would
  276. be blank for public chat.  Any string up to 12 characters in length
  277. may be placed in this field.  It is not case sensitive.
  278.  
  279. Time Warning Frequency    Due to a bug in ProKit, I implemented
  280. this to notify users every so often of how much time is remaining. 
  281. You may disable this completely by entering 0.  Any other value
  282. will cause a message to be displayed to the user every xx minutes
  283. telling the caller how much time he or she has remaining for the
  284. call.  xx is the number you place in this field.
  285.  
  286. Allow use of handles    If you do not wish to allow handles to be
  287. used in chat, the caller's first name will be used instead.  If
  288. this field is set to no, the /HA command will not be allowed
  289. regardless of the security level you have placed on it.  If this
  290. flag is set to yes, upon entering ProChat, the caller will be asked
  291. for a handle to use with their first name being the default. 
  292. Handles are limited to 12 characters in length.
  293.  
  294. Allow duplicate handles    If this field is set to yes, ProChat
  295. will allow users to use the same handle as someone on another node. 
  296. For instance, if the caller on node 1 was using the handle "The
  297. Doctor", a caller on node 2 could also use the handle "The Doctor". 
  298. If this field is set to no, ProChat will not allow users to use the
  299. same handle as someone else.
  300.  
  301. Use fast message check method    ProChat checks it's data files for
  302. incoming messages once every 5 seconds.  If this field is set to
  303. yes, ProChat will still check every 5 seconds, only if the user has
  304. nothing typed on his/her input line.  If this field is set to no,
  305. ProChat will check every 5 seconds, whether or not the user has
  306. anything typed on his/her input line.  Setting this field to yes
  307. will speed the system up, however slow typists may fall behind in
  308. receiving incoming messages.
  309.  
  310. Allow paging in PCBoard    If this field is set to no, ProChat will
  311. not allow users to page another user that is in PCBoard.  If this
  312. field is set to yes, ProChat will send a chat request to a user in
  313. PCBoard if the caller requests it to be sent.
  314.  
  315. Allow paging in ProChat    If this field is set to no, ProChat will
  316. not allow users to page other users that are also in ProChat.  This
  317. was added as a prevention for "death paging" where one user could
  318. send countless page requests to another user in ProChat.  If this
  319. field is set to yes, ProChat will allow users to page others in
  320. ProChat.
  321.  
  322. Show private messages to sysop    If this field is set to yes, the
  323. Sysop (if in ProChat) will receive the private messages from all
  324. users.  If this field is set to no, only the addressee will receive
  325. the private message sent from someone.
  326.  
  327. Display city in node scan    This is the same option as found in
  328. PCBSetup.  The reason it is here too is because ProKit does not
  329. provide a link to this option in PCBoard (and I was just plain too
  330. lazy to reread the pcboard.dat file)
  331.  
  332. SETUP PAGE 2
  333. ------------
  334.      The second page in setup is nothing more than a list of all of
  335. the commands available to users in ProChat and a security level
  336. attached to each.  To switch back to page 1, press the F2 key.
  337.  
  338. PROCHAT COMMANDS
  339. ----------------
  340. /AC - Perform action command    This command allows users to show
  341. emotion to other users.  The messages come across to other nodes
  342. without the tradition incoming message header ("(channel, handle)
  343. message").  Instead the come across in the format of "handle
  344. message".  Incoming action messages are also displayed in a
  345. different color (in ansi mode) from normal incoming messages.
  346.  
  347. /AD - Adjust time left    This command should be available to
  348. Sysops only.  With this command, you may adjust the time left of a
  349. caller on another node in ProChat.  By selecting a negative adjust
  350. value, time will be reduced, and a positive adjust value will
  351. increase time remaining.  The caller to be adjusted must be in
  352. ProChat.  You cannot adjust your own time limit.
  353.  
  354. /AN - Ansi mode toggle    This command is exactly like the PCBoard
  355. main board command M (display mode change).  It toggles between
  356. ansi and non-ansi modes.
  357.  
  358. /AV - Page availability toggle    This command allows users to
  359. toggle whether or not they want to receive ProChat page requests. 
  360. ProChat never displays a page request from PCBoard (since PCBoard
  361. will not send a page request to a caller with a Group chat status). 
  362. If the user selects unavailable, other callers will be notified
  363. when they attempt to page the user.  The default availability
  364. setting is to available.
  365.  
  366. /CH - Change active channel    Allows users to switch among
  367. channels within the limit you have set up in ProChat.  When
  368. changing the channel, other users will be notified that the user
  369. has switched out, and the users chatting on the new channel will be
  370. notified that the user has switched in.
  371.  
  372. /FR - Frequency node scan    Displays to the user a list of other
  373. users that are chatting on the same channel with the same squelch
  374. value of the user.
  375.  
  376. /GO - Goodbye    Logs the user off of the system.  Other users will
  377. be notified that the user has been disconnected.
  378.  
  379. /HA - Change handle    Allows the user to change his or her handle
  380. as shown to other users with incoming messages.  If you have chosen
  381. to not allow handles in setup, this command will not execute.
  382.  
  383. /IG - Set Ignore handle    Allows users to create and maintain a
  384. list of handles that they do not want to receive incoming messages
  385. from.  If a message comes through from a handle the user has chosen
  386. to ignore, it is ignored and no action is taken.  If the user
  387. chooses a handle that is already being ignored, ignore status will
  388. be removed from that handle.  If the handle being ignored changes,
  389. incoming messages will once again come through since ProChat only
  390. looks at the handle text that it is coming from.  Users may create
  391. a list of up to 20 handles to ignore.  Once the user exits ProChat,
  392. the list is destroyed.
  393.  
  394. /MO - Set channel monitors    Allows users to monitor incoming
  395. messages from channels other than the one he/she is chatting on. 
  396. Users may also choose squelch values for the channels chatting on. 
  397. A list of up to 10 different monitors (channel and squelch
  398. combinations) may be maintained.
  399.  
  400. /NO - ProChat node scan    Displays to the user a list of users
  401. that are in ProChat.  It tells the user what channel the user is
  402. chatting on, what their handle and real name is, and what speed the
  403. user is connected at (ie 2400bps)
  404.  
  405. /PA - Page user for chat    Allows the user to send a chat request
  406. to another user.  There are three different methods that ProChat
  407. may use to page the caller.  If the caller is in ProChat, ProChat
  408. will send a page request notifying the caller of the channel and
  409. squelch value that the paging user is chatting with.  If the caller
  410. is in PCBoard and the new usernet.xxx format is being used, the
  411. caller in PCBoard will receive a broadcast message telling the user
  412. that he or she is wanted in ProChat.  If the caller is in PCBoard,
  413. but the old usernet.dat format is being used, the caller in PCBoard
  414. will be paged in the traditional PCBoard style.  In which case, the
  415. PCBTEXT lines mentioned earlier in the document would have to be
  416. modified for the caller to know to go into ProChat.
  417.  
  418. /PC - PCBoard node scan    Displays to the caller a list of all
  419. callers on the system and their current activity status.  It is
  420. equivalent to the PCBoard WH and 11 commands.
  421.  
  422. /RE - Log user off system    This command should be available to
  423. Sysop level users only.  This operates in a similar fashion to the
  424. PCBoard 12 command.  The only difference being the user must be in
  425. ProChat for it to work.
  426.  
  427. /SE - Send private message    Allows the user to send a message to
  428. another user in ProChat no matter what channel or squelch value
  429. either is using.  Only the addressee will receive the message.  If
  430. the Sysop is in ProChat and has chosen to receive private messages,
  431. the Sysop will also see the message being sent.  When received, the
  432. addressee will receive a beep and be notified that it is a private
  433. message.
  434.  
  435. /SQ - Change squelch value    Allows the user to change his or her
  436. squelch value.  A squelch value is used to establish private
  437. communication with one or more users on other nodes.  If the user
  438. has his/her squelch set to blank, he or she is considered to be in
  439. public chat mode.
  440.  
  441. /TI - Time statistics    Displays to the caller the number of
  442. minutes used and number of minutes remaining for him/her for this
  443. call.
  444.  
  445. /WH - Who else is chatting    Displays a list of callers that are
  446. chatting with the same channel and squelch settings as the user. 
  447. This command is different from the /FR command because it displays
  448. in sentence format the handles that the user is chatting with (ie
  449. "You are chatting with no one." or "You are chatting with Sysop,
  450. Mary, John.")
  451.  
  452. TROUBLE SHOOTING
  453. ----------------
  454. Problem: Users are not receiving any form of messages from other  
  455.        users.
  456. Solution: Make sure that all of the data files labels in the setup 
  457.          section as "Must be the same for all nodes" are the same 
  458.          for all nodes.
  459.  
  460. Problem: Users are receiving "Nobody is listening on this channel" 
  461.         messages when there are other users with the same chat    
  462.      settings (channel, squelch).
  463. Solution: Delete your channels.dat file and start ProChat up again.
  464.  
  465. REGISTRATION
  466. ------------
  467.      ProChat is not crippled in any way.  The only difference
  468. between the registered and unregistered versions of ProChat is that
  469. the unregistered version displays unregistered messages to the
  470. caller.  When registered, ProChat will proudly display the name of
  471. your bulletin board as it is registered to.
  472.  
  473.      Registration for ProChat is cheap and simple.  When I receive
  474. your registration request in the mail, I will call your system and
  475. leave a message with your registration information in it.  The
  476. registration fee for prochat is a base of $25.  If you run a system
  477. larger than 5 nodes, please add (to the $25) $5 for each additional
  478. node (ie 8 nodes would be $25 + ($5 * 3) = $40)  Please send check
  479. or money order only.  If you are registering from outside the US
  480. (ie Canada, or some other foreign country), please add an
  481. additional $5 for processing.  Thank you!
  482.  
  483. SUPPORT
  484. -------
  485.      At present, I am away at college and am not running a
  486. bulletin board.  The best way to reach me would be on Springboard
  487. BBS (401-232-0088) or Eagles Nest Communications (401-732-5292). 
  488. On Springboard, please address messages to "Fistandantilus".  Thank
  489. you!
  490.  
  491. I can be reached at the following address:
  492.  
  493.      Bryant College
  494.      Student PO Box 2144
  495.      Smithfield, RI
  496.      02917
  497.  
  498. --           OR --
  499.  
  500.      ProChat registration
  501.      c/o Matt Messier
  502.      3 Loring Drive
  503.      Lincoln, RI
  504.      02865
  505. REGISTRATION FORM
  506. -----------------
  507.  
  508.      Your name   ___________________________________________
  509.  
  510.      BBS name (as to appear for "Registered To" field - max 40)
  511.  
  512.      _______________________________________________________
  513.  
  514.      BBS location    _______________________________________
  515.  
  516.      BBS Phone #    ________________________________________
  517.  
  518.      Account name to log on as (for me to give you your
  519.      registration information
  520.  
  521.      _______________________________________________________
  522.  
  523.      Account password    ___________________________________
  524.  
  525.      Your home phone #    __________________________________
  526.  
  527.      Street address    _____________________________________
  528.  
  529.      _______________________________________________________
  530.      
  531.      _______________________________________________________
  532.  
  533.      Number of nodes online    _____________________________
  534.  
  535.      
  536.     Quantity                                        Amount        
  537.  
  538.  
  539.      _____    $25 base fee                        __________
  540.  
  541.      _____    (#) additional nodes (over 5)       __________
  542.  
  543.      _____    Foreign processing fee              __________
  544.  
  545.               Total enclosed                      __________
  546.  
  547.  
  548.  
  549.      Signature  ____________________________________________
  550.  
  551.      Date  _______________